FrameLib_Global.h

Go to the documentation of this file.

#ifndef FRAMELIB_GLOBAL_H
#define FRAMELIB_GLOBAL_H

#include "FrameLib_Types.h"
#include "FrameLib_Errors.h"
#include "FrameLib_Memory.h"
#include "FrameLib_ProcessingQueue.h"
#include "FrameLib_Threading.h"

#include <memory>
#include <vector>

class FrameLib_Global : public FrameLib_ErrorReporter
{

    friend class FrameLib_Context;
    
private:

    template <class T> class PointerSet
    {
        // A simple countable pointer with a reference address
        
        struct CountablePointer
        {
            CountablePointer(T* object, void *reference) : mObject(object), mReference(reference), mCount(1) {}
            
            std::unique_ptr<T> mObject;
            void *mReference;
            long mCount;
        };
        
    public:
        
        // Add, find or release an object by reference address
        
        void add(T *object, void *reference);
        T *find(void *reference);
        void release(void *reference);
        
    private:
        
        // Internal Pointers
        
        std::vector<CountablePointer> mPointers;
    };
    
public:
        
    static FrameLib_Global *get(FrameLib_Global **global, FrameLib_ErrorReporter::HostNotifier *notifier = nullptr);
    
    static void release(FrameLib_Global **global);
        
private:
    
    // Constructor / Destructor
    
    FrameLib_Global(FrameLib_ErrorReporter::HostNotifier *notifier) : FrameLib_ErrorReporter(notifier), mAllocator(*this), mCount(0) {}
    ~FrameLib_Global() {};
    
    // Non-copyable
    
    FrameLib_Global(const FrameLib_Global&) = delete;
    FrameLib_Global& operator=(const FrameLib_Global&) = delete;
    
    // Methods to retrieve common objects

    FrameLib_LocalAllocator *getAllocator(void *reference);
    FrameLib_ProcessingQueue *getProcessingQueue(void *reference);
    
    // Methods to release common objects

    void releaseAllocator(void *reference);
    void releaseProcessingQueue(void *reference);
    
    // Reference Counting / Auto-deletion
    
    void increment();
    FrameLib_Global *decrement();
    
    // Member Variables
    
    // Global Memory Allocator
    
    FrameLib_GlobalAllocator mAllocator;
    
    // Context-specific Resources
    
    PointerSet<FrameLib_LocalAllocator> mLocalAllocators;
    PointerSet<FrameLib_ProcessingQueue> mProcessingQueues;
    
    // Lock and Reference Count
    
    FrameLib_SpinLock mLock;
    long mCount;
};

#endif